<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ArchitectureRulesReport xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../src/git-mirrors/com.googlecode.architecturerules/maven-architecture-rules-plugin/target/site/apidocs/info/manandbytes/architecturerules/report/ArchitectureRulesReport.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> info.manandbytes.architecturerules.report;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport;
<a name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
<a name="6" href="#6">6</a>   
<a name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> org.codehaus.doxia.sink.Sink;
<a name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> org.codehaus.doxia.site.renderer.SiteRenderer;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> java.util.ResourceBundle;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment">/**</em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://docs.codehaus.org/display/MAVENUSER/Write+your+own+report+plugin" target="alexandria_uri">http://docs.codehaus.org/display/MAVENUSER/Write+your+own+report+plugin</a>"&gt;</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * Write your own report plugin&lt;/a&gt;</em>
<a name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> *</em>
<a name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * @author mn</em>
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * @goal report</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * @phase site</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> */</em>
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../info/manandbytes/architecturerules/report/ArchitectureRulesReport.html">ArchitectureRulesReport</a>
<a name="22" href="#22">22</a>      <strong class="jxr_keyword">extends</strong> AbstractMavenReport
<a name="23" href="#23">23</a>  {
<a name="24" href="#24">24</a>      <em class="jxr_javadoccomment">/**</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;Directory where reports will go.&lt;/p&gt;</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">     *</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment">     * @parameter expression="${project.reporting.outputDirectory}"</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment">     * @required</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">     * @readonly</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment">     */</em>
<a name="31" href="#31">31</a>      <strong class="jxr_keyword">private</strong> String outputDirectory;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>      <em class="jxr_javadoccomment">/**</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">     * @see AbstractMavenReport#executeReport(Locale)</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">     */</em>
<a name="36" href="#36">36</a>      @Override
<a name="37" href="#37">37</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeReport( <strong class="jxr_keyword">final</strong> Locale locale )
<a name="38" href="#38">38</a>                            <strong class="jxr_keyword">throws</strong> MavenReportException
<a name="39" href="#39">39</a>      {
<a name="40" href="#40">40</a>          <em class="jxr_comment">// TODO Auto-generated method stub</em>
<a name="41" href="#41">41</a>          <strong class="jxr_keyword">final</strong> Sink sink = getSink(  );
<a name="42" href="#42">42</a>          sink.head(  );
<a name="43" href="#43">43</a>          sink.title(  );
<a name="44" href="#44">44</a>          sink.text( getBundle( locale ).getString( <span class="jxr_string">"title"</span> ) );
<a name="45" href="#45">45</a>          sink.title_(  );
<a name="46" href="#46">46</a>          sink.head_(  );
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>          sink.body(  );
<a name="49" href="#49">49</a>          sink.body_(  );
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>          sink.flush(  );
<a name="52" href="#52">52</a>          sink.close(  );
<a name="53" href="#53">53</a>      }
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @see AbstractMavenReport#getOutputDirectory()</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     */</em>
<a name="58" href="#58">58</a>      @Override
<a name="59" href="#59">59</a>      <strong class="jxr_keyword">protected</strong> String getOutputDirectory(  )
<a name="60" href="#60">60</a>      {
<a name="61" href="#61">61</a>          <strong class="jxr_keyword">return</strong> outputDirectory;
<a name="62" href="#62">62</a>      }
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>      <em class="jxr_javadoccomment">/**</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * @parameter expression="${project}"</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * @required</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     * @readonly</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     */</em>
<a name="69" href="#69">69</a>      <strong class="jxr_keyword">private</strong> MavenProject project;
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <em class="jxr_javadoccomment">/**</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * @see AbstractMavenReport#getProject()</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     */</em>
<a name="74" href="#74">74</a>      @Override
<a name="75" href="#75">75</a>      <strong class="jxr_keyword">protected</strong> MavenProject getProject(  )
<a name="76" href="#76">76</a>      {
<a name="77" href="#77">77</a>          <strong class="jxr_keyword">return</strong> project;
<a name="78" href="#78">78</a>      }
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * @component</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     */</em>
<a name="83" href="#83">83</a>      <strong class="jxr_keyword">private</strong> SiteRenderer siteRenderer;
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em class="jxr_javadoccomment">/**</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * @see AbstractMavenReport#getSiteRenderer()</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     */</em>
<a name="88" href="#88">88</a>      @Override
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">protected</strong> SiteRenderer getSiteRenderer(  )
<a name="90" href="#90">90</a>      {
<a name="91" href="#91">91</a>          <strong class="jxr_keyword">return</strong> siteRenderer;
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <em class="jxr_javadoccomment">/**</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * @see AbstractMavenReport#getDescription(Locale)</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     */</em>
<a name="97" href="#97">97</a>      <strong class="jxr_keyword">public</strong> String getDescription( <strong class="jxr_keyword">final</strong> Locale locale )
<a name="98" href="#98">98</a>      {
<a name="99" href="#99">99</a>          <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"description"</span> );
<a name="100" href="#100">100</a>     }
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <em class="jxr_javadoccomment">/**</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @see AbstractMavenReport#getName(Locale)</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     */</em>
<a name="105" href="#105">105</a>     <strong class="jxr_keyword">public</strong> String getName( <strong class="jxr_keyword">final</strong> Locale locale )
<a name="106" href="#106">106</a>     {
<a name="107" href="#107">107</a>         <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"name"</span> );
<a name="108" href="#108">108</a>     }
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>     <em class="jxr_javadoccomment">/**</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * &lt;p&gt;Name of a file with generated architecture rules report&lt;/p&gt;</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     *</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.AbstractMavenReport#getOutputName()</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     */</em>
<a name="115" href="#115">115</a>     <strong class="jxr_keyword">public</strong> String getOutputName(  )
<a name="116" href="#116">116</a>     {
<a name="117" href="#117">117</a>         <strong class="jxr_keyword">return</strong> <span class="jxr_string">"architecture-rules"</span>;
<a name="118" href="#118">118</a>     }
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a>     <strong class="jxr_keyword">private</strong> ResourceBundle getBundle( <strong class="jxr_keyword">final</strong> Locale locale )
<a name="121" href="#121">121</a>     {
<a name="122" href="#122">122</a>         <strong class="jxr_keyword">final</strong> String name = <span class="jxr_string">"architecture-rules-report"</span>;
<a name="123" href="#123">123</a>         <strong class="jxr_keyword">final</strong> ClassLoader classLoader = <strong class="jxr_keyword">this</strong>.getClass(  ).getClassLoader(  );
<a name="124" href="#124">124</a> 
<a name="125" href="#125">125</a>         <strong class="jxr_keyword">return</strong> ResourceBundle.getBundle( name, locale, classLoader );
<a name="126" href="#126">126</a>     }
<a name="127" href="#127">127</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

